Skip to content

[Contributing] tweaks to the contribution chapter #4245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2014

Conversation

xabbuh
Copy link
Member

@xabbuh xabbuh commented Sep 17, 2014

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets

Some tweaks for the changes made in #4223.

@javiereguiluz Sorry, didn't find the time to review it in the first run.


More than 800 developers all around the world have contributed to Symfony's
documentation, and we are glad that you are considering joining this big family.
More than 700 developers all around the world have contributed to Symfony's
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In http://symfony.com/contributors/doc you can se that there are 794 people identified as documentation contributors. Don't you think it's better to say more than 800? Otherwise, this figure will be out-dated pretty soon.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On https://github.com/symfony/symfony-docs, the number of contributors is 721. Do you know where the figure on symfony.com is coming from?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xabbuh the github UI counts the number of github accounts. symfony.com counts the number of distinct email addresses. So there is 2 sources of differences:

  • people with several email addresses associated to their github account
  • people contributing with an email address not associated to their github account

@javiereguiluz why would it be outdated ? 850 is still more than 700 😄. The only way it could be outdated is when the number of contributors become lower than 700, which is not possible

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If symfony.com counts unique e-mail addresses, the GitHub count seems more reasonable to me. For example, I used at least two different e-mail addresses in commit messages and I see no reason why this should be counted for two contributors.

Admittedly, this may look weird if people have at the contributors on symfony.com after reading this sentence. However, when you read this and then see the figure on GitHub, this seems even more weird. As @stof said, "more than 700" is true for both figures. :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, let's keep the low figure.

However, GitHub is a closed source service, which means that we don't know what they really do to count contributions. This help article explains some things, such as the cases where contributions aren't counted: https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the doc you linked talks about criteria for the contributions on the profile page. for repo contributors the rules are explained at https://help.github.com/articles/i-don-t-see-myself-in-the-repository-contributors-graph

the only case impacting us here is the case of email addresses not being linked to an account (and so ignored by github when building the list) or several addresses for the same user. The criteria about contributing to the default branch is not an issue given that other branches are merged in master regularly

@javiereguiluz
Copy link
Member

👍 nice improvements @xabbuh. Thanks!

@weaverryan
Copy link
Member

Very nice changes! Thanks Christian!

@weaverryan weaverryan merged commit f4b0b8e into symfony:2.3 Oct 2, 2014
weaverryan added a commit that referenced this pull request Oct 2, 2014
This PR was merged into the 2.3 branch.

Discussion
----------

[Contributing] tweaks to the contribution chapter

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets |

Some tweaks for the changes made in #4223.

@javiereguiluz Sorry,  didn't find the time to review it in the first run.

Commits
-------

f4b0b8e tweaks to the contribution chapter
@xabbuh xabbuh deleted the pr-4223-tweaks branch October 2, 2014 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants